﻿//_______________________________________________________________________________________________________________________
// Copy Right (c) 2010, 2011 SapiensIT Consulting GmbH, all rights reserved
//_______________________________________________________________________________________________________________________
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT
// NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
//_______________________________________________________________________________________________________________________
// PROJECT:     sapiens.at.SharePoint.QueryBuilder (SharePoint 2010/V4)
//_______________________________________________________________________________________________________________________
// VERSION:     2.0
//_______________________________________________________________________________________________________________________
// DESCRIPTION: 
//_______________________________________________________________________________________________________________________
// LICENSE:     Different licens Types apply to different file types:
//               - Source code files are governed by the MICROSOFT PUBLIC LICENSE (Ms-PL)
//               - Binary files are governed by MSDN CODE GALLERY BINARY LICENSE
//               - Documentation files are governed by CREATIVE COMMONS ATTRIBUTION 3.0 LICENSE
//
//               The licenses can be found at the projects source location.
//               If you do not agree, don't use it!
// 
//_______________________________________________________________________________________________________________________
// Start SharePoint Branding, visit http://www.cliggin.com! Visit us on http://www.sapiens.at! Tell your friends! 
//_______________________________________________________________________________________________________________________
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.SharePoint.Utilities;

namespace Sapiens.at.SharePoint.Utils
{
    /// <summary>
    /// Represents a CAML expression used in an OrderBy.
    /// </summary>
    public class QueryBuilderOrderByOperator
    {
        /// <summary>
        /// Gets or sets the field name for the operator.
        /// </summary>
        protected string FieldRef { get; set; }

        /// <summary>
        /// Gets or sets the order direction for the operation
        /// </summary>
        protected bool Ascending { get; set; }

        /// <summary>
        /// Instantiates a new operator.
        /// </summary>
        /// <param name="fieldRef">The <see cref="FieldRef"/> of the expression</param>
        public QueryBuilderOrderByOperator(string fieldRef)
            : this(fieldRef, false)
        { }

        /// <summary>
        /// Instantiates a new operator.
        /// </summary>
        /// <param name="fieldRef">The <see cref="FieldRef"/> of the expression</param>
        /// <param name="ascending"></param>
        public QueryBuilderOrderByOperator(string fieldRef, bool ascending)
        {
            FieldRef = fieldRef;
            Ascending = ascending;
        }

        /// <summary>
        /// Converts the expression into the CAML representation.
        /// </summary>
        /// <returns>The CAML query for this expression</returns>
        public override string ToString()
        {
            return string.Format("<FieldRef Name=\"{0}\" Ascending=\"{1}\" />", FieldRef, Ascending ? "TRUE" : "FALSE");
        }
    }
}
